/*
 * @(#) $Header$
 *
 * Copyright (C) 2011  Daniel Léonard
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

package ca.forklabs.baselib.util.comparator;

import java.util.Comparator;

/**
 * Class {@code ComparableComparator} creates a {@link Comparator} for any
 * {@link Comparable} type.
 *
 * @param   <C>   the comparable type.
 *
 * @author   <a href="mailto:forklabs at gmail.com?subject=ca.forklabs.baselib.util.comparator.ComparableComparator">Daniel Léonard</a>
 * @version $Revision$
 */
@SuppressWarnings("rawtypes")
public class ComparableComparator<C extends Comparable> implements Comparator<C> {

//---------------------------
// Constructors
//---------------------------

   /**
    * Constructor.
    */
   public ComparableComparator() {
   // nothing
      }


 //---------------------------
// Class methods
//---------------------------

   /**
    * {@inheritDoc}
    */
   @Override
   @SuppressWarnings("unchecked")
   public int compare(C c1, C c2) {
      int comparison = c1.compareTo(c2);
      return comparison;
      }


//---------------------------
// Class methods
//---------------------------

   /**
    * Creates a new comparator.
    * @param   <C>   the comparable type.
    * @return   a new comparator.
    */
   public static <C extends Comparable> Comparator<C> create() {
      return new ComparableComparator<>();
      }

   }
